/*
 * Copyright 2012-2019 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.boot.configurationdocs;

/**
 * Abstract class for entries in {@link ConfigurationTable}.
 *
 * @author Brian Clozel
 */
abstract class ConfigurationTableEntry implements Comparable<ConfigurationTableEntry> {

	protected String key;

	String getKey() {
		return this.key;
	}

	abstract void write(AsciidocBuilder builder);

	@Override
	public boolean equals(Object obj) {
		if (this == obj) {
			return true;
		}
		if (obj == null || getClass() != obj.getClass()) {
			return false;
		}
		ConfigurationTableEntry other = (ConfigurationTableEntry) obj;
		return this.key.equals(other.key);
	}

	@Override
	public int hashCode() {
		return this.key.hashCode();
	}

	@Override
	public int compareTo(ConfigurationTableEntry other) {
		return this.key.compareTo(other.getKey());
	}

}
